Registered User Variable
The user variable stores information for each far-end user registered with the device and maintains it as long as the user is registered. The user variables can be accessed from all SIP dialogs which the user is involved in.
Syntax:
var.user|peer-user.<Variable Name>
where:
| ■ | user denotes the user of the current leg |
| ■ | peer-user denotes the user of the peer leg |
| ■ | <Variable Name> specifies the name of the variable |
Usages:
| ■ | Inbound and outbound message manipulation |
| ■ | Call Setup Rules (only var.user) |
| ■ | IP-to-IP Routing table: |
| ● | 'Message Condition' field (only var.user and read-only) |
| ● | 'Internal Action' field (only var.user and read-only) |
| ● | This section is applicable only to the SBC application. |
| ● | The user variable cannot be used in Outbound Manipulation for operations that are terminated before Classification, Manipulation and Routing (responses for REGISTER termination, Reply internal action, CMR failure). |
| ● | When a registered user expires and the device generates and sends an un-REGISTER to the proxy, you can configure outbound manipulation for the Server-type IP Group (i.e., proxy) using the param.ipg.src|dst.<x> syntax. For this stage, you can also use the var.peer-user variable. |
The following table provides a configuration example of user variables in Message Manipulation rules.
| ■ | Index 1: When the REGISTER response (200 OK) contains the Proprietary-Header header, the device stores it in a user variable ("myheader"). |
| ■ | Index 2: This variable ("myheader") is later used to add a Proprietary-Header header to subsequent 200 OK responses for REGISTER messages (that do not contain the header) sent to that user, without requiring it to be re-sent by the registrar. |
Examples of User Variables
|
Index |
Message Type |
Condition |
Action |
Action Type |
Action Value |
|---|---|---|---|---|---|
|
1 |
register.response.200 |
header.proprietary-header exists |
var.user.myheader |
Modify |
header.proprietary-header |
|
2 |
register.response.200 |
header.proprietary-header !exists |
header.proprietary-header |
Add |
var.user.myheader |